CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /projects/{projectId}/objects (Get)
In This Topic
    Get/projects/{projectId}/objects
    In This Topic
    Description
    returns a list of objects in a project that satisfy the filter criteria
    Parameters
    NameDescriptionData Type
    projectIdthe id of the project to look instring
    skipnumber of records to skip for paginationinteger (int32)
    limitmaximum number of records to returninteger (int32)
    ObjectIDprovides a wild card string to filter objects by their objectId.string
    ClassIDClass ID for the object provides a wild card string to filter the object list by classId.string
    Descriptionprovides a wild card string to filter objects by their description.string
    200 Response

    The response body is of type ClassObjectResponse.

    CimObjectInstance list results matching criteria

    Overview

    ClassObjectResponse
    The results of the objects get query
    Objects : Array[CimObjectInstance]
    ID : string
    ClassID : string
    Description : string
    Attributes : Array[CimAttribute]
    ID : string
    Value : string
    Routing : Array[string]
    Fault Responses
    FaultDescription
    404This fault returns a response body of type ProblemDetails.
    project with the given id is not registered on the system
    Remarks
    By passing a registered project id you can get a list of classes in this project
    See Also
    All Operations Resource Group | CIMPLICITY Configuration REST API Web Service

     

     

    © 2024 GE Vernova and/or its affiliates. All rights reserved.

    Send comments on this topic.